Skip to content

Fix build failure caused by lack of mmCif format short description - #447

Merged
orbeckst merged 1 commit into
MDAnalysis:developfrom
jpkrowe:fix-cif-format-description
Nov 15, 2026
Merged

orbeckst merged 1 commit into
MDAnalysis:developfrom
jpkrowe:fix-cif-format-description

Conversation

@jpkrowe

@jpkrowe jpkrowe commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

PR MDAnalysis/mdanalysis#4712 added an mmCIF reader and parser registered as CIF, CIF.GZ, MMCIF and MMCIF.GZ, which causes the userguide to fail with KeyError: 'CIF'.

This partially fixes #441 as it doesn't add a full rst file for the format.

  • add a CIF entry to DESCRIPTIONS
  • add .upper to format dictionary key selection to avoid having to define entries for cif.gz, mmcif and mmcif.gz

📚 Documentation preview 📚: https://mdanalysisuserguide--447.org.readthedocs.build/en/447/

PR MDAnalysis/mdanalysis#4712 added an mmCIF reader and parser
registered as CIF, CIF.GZ, MMCIF and MMCIF.GZ, which caused the
userguide to fail with KeyError: 'CIF'.

- add a CIF entry to DESCRIPTIONS
- add `.upper` to format dictionary key selection to avoid having to
define entries for cif.gz, mmcif and mmcif.gz
@orbeckst

orbeckst commented Nov 15, 2026 •

Copy link
Copy Markdown
Member
  • pre-commit fails with something weird in black – not this PR's fault as far as I can tell, see [CI] black in pre-commit broken #444
  • the example tests failures are benign: PCA lost a 0j (inconsequential) and ENCORE is always flaky.

@orbeckst orbeckst self-assigned this Nov 15, 2026

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jpkrowe . Sorry for the lack of review...

I am going to merge even though we don't have a full format page description. That can be something for another day.

(There are various CI issues but I am just going to merge this blind, given that the existing failures are not due to this PR and that it fixes the major issue with the build_docs workflow.)

@orbeckst
orbeckst merged commit 158db4c into MDAnalysis:develop Nov 15, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add mmcif/PDBx functionality

2 participants